/**
 * @file: BaseSwaggerConfig
 * @author :zhengzhicheng
 * @date:2020/8/27 13:48
 * @copyright:2020-2023 www.bosssoft.com.cn Inc. All rights reserved
 */
package com.bosssoft.common.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;


/**
 * SwaggerConfig 类用于配置 Swagger API 文档生成。
 */
@Slf4j
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    // 注入 MySwaggerProperties 配置类的实例
    private final MySwaggerProperties swaggerProperties;

    /**
     * 使用 @Autowired 注解，通过构造函数注入 MySwaggerProperties。
     *
     * @param swaggerProperties 包含 Swagger 配置信息的 MySwaggerProperties 实例
     */
    @Autowired
    public SwaggerConfig(MySwaggerProperties swaggerProperties) {
        this.swaggerProperties = swaggerProperties;
    }

    /**
     * 创建用于生成 API 文档的 Docket Bean。
     *
     * @return 配置后的 Docket 实例
     */
    @Bean
    public Docket createRestApi() {
        log.info("SwaggerConfig.createRestApi call");
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getApiBasePackage()))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    /**
     * 配置 API 的基本信息（如标题、描述、版本、联系人信息等）。
     *
     * @return 配置后的 ApiInfo 实例
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(swaggerProperties.getTitle())
                .description(swaggerProperties.getDescription())
                .contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(), swaggerProperties.getContactEmail()))
                .version(swaggerProperties.getVersion())
                .build();
    }
}

